Stamp Area Tags

The following tags are used in a stamp-area block in a DiveTab script.

Tag

Examples

Status

Notes

stamp-area

stamp-area {

...

}

Required

Defines the block for the stamp page.
analysis-column

Using DiveTab 7.1(21) and later:

stamp "R12-to-Date vs LY R12-to-Date" label = "R12" {

text {

rolling-months 12

previous-year {

difference

percent-difference

}

}

analysis-column "R3-to-Date vs LY R3-to-Date"

analysis-column "R6-to-Date vs LY R6-to-Date"

}

 

Using DiveTab 7.1(20) and earlier:

stamp "R12" calendar = "standard" range = "rolling 12" previous = "previous-year" label = "R12" {

analysis-column "R3"

analysis-column "R6"

}

 Optional Identifies columns from different stamp analysis pages to be added to the current stamp analysis page.

areas

areas {

...

}

Required

Defines the outer level block for one or more areas.
bar-chart

bar-chart {

rolling-months 12

previous-year

}

Optional

Defines the display area in the stamp as a bar chart.

NOTE: Available in DiveTab 7.1(21) and later.
calendar

Using DiveTab 7.1(21) and later:

stamp "R6-to-Date vs LY R6-to-Date" {

text {

calendar "fiscal"

rolling-months 6

previous-year

}

}

 

Using DiveTab 7.1(20) and earlier:

stamp "R6" calendar = "standard" range = "rolling 6" previous = "previous-year"

In DiveTab 7.1(20) and earlier:

Required

In DiveTab 7.1(21) and later:

Optional

Defines a calendar to use for the stamp.

NOTE: In DiveTab 7.1(21) and later, the calendar attribute is optional. Standard is the default. Any other factory calendars defined in the Measure Factory script, such as Fiscal, can be used.
column-title

stamp "MTD vs LY Complete Month" label = "Month Stamp" {

bar-chart {

year-to-date {

label "Current" {

column-title "Title A"

}

}

}

}

 Optional

Provides an alternate name for the stamp analysis page's column titles than the text in the stamp for the time-range-tag, text-comparison-tag, and additional comparison values.

NOTE: Available in DiveTab 7.1(25) and later.
default-stamp default-stamp measure = "Net Sales" stamp = "YTD" Optional Defines a stamp that appears upon initial opening of the stamp page.
default-stamp-book default-stamp-book "All" Optional Identifies the default stamp-book when not identified by the measure.
default-stamps

default-stamps {

default-stamp measure = "Cases" stamp = "YTD"

}

 Optional Defines the block containing one or more default-stamps.
dimension

dimensions {

dimension "Division Manager"

dimension "Chain"

}

 Required Identifies a dimension that is available for diving on the stamp analysis page. The dimension is a viable option if it is identified by the measure in Measure Factory.
dimensions

dimensions {

...

}

 Required Defines a block of dimensions that are available for diving on the stamp analysis page.
external-central-page id external-central-page id = "cp-customer-details" area-id = "data-area-landing" Optional

Creates an external central page link in the stamp analysis page.

NOTE: Available in DiveTab 7.1(21) and later.
factory-name factory-name "mf_training_jc" Required Identifies the Measure Factory project from which the stamp-area pulls measures.
filter

filter "Customer"

filter "Product Type"

 Optional Defines the QuickViews for filtering the stamp-area. Depending on a stamp's measure, one or more of the filters might not apply to it nor appear on the stamp analysis page.
filters

filters {

filter "Group"

filter "State"

}

 Optional Defines the block of filters.

icon

icon "/divetab/images/icon.png" retina = false

Optional

Specifies the graphic for the button icon.

id

stamp-area id = "stamp-area" {

...

}

Required

Provides a means to refer to this stamp-area block.

Place after the stamp-area tag and before the open brace, {.
label

Using DiveTab 7.1(25) and later:

stamp "R12" label = "R12 Months" {

text {

rolling-months 12 {

label "Current"

}

previous-year {

difference {

label "Delta"

}

label "Prior"

}

label "R12-to-Date vs LY R12-to-Date"

}

}

Using DiveTab 7.1(21) and later:

stamp "R12" label = "R12 Months" {

text {

rolling-months 12

previous-year {

difference

}

}

}

 

Using DiveTab 7.1(20) and earlier:

stamp "R12" calendar = "standard" range = "rolling 12" previous = "previous-year" label = "R12 Months"

 Optional

In DiveTab 7.1(24) and earlier: Attach to the stamp tag to provide an alternate name for the stamp title.

In DiveTab 7.1(25) and later: Attach to the stamp tag, time-range-tag, text-comparison-tag, additional comparison values, and middle text to customize stamps.
line-chart

line-chart {

year-to-date

previous-year {

difference

}

 Optional

Defines the display area in the stamp as a line-chart.

NOTE: Available in DiveTab 7.1(21) and later.
measure

measure "Gross Sales"

measure "Cost" stamp-book = "Rolling"

 Required Specifies a measure that can be used with a stamp.
previous stamp "Today vs Yesterday" calendar = "standard" range = "current-day" previous = "previous-day" Required

Defines the time range to use for the stamp along with the range attribute. The available options are: previous-year and previous-day. The previous-day option can only be used with the current-day range tag.

NOTE: Applies to DiveTab 7.1(20) and earlier.
range

stamp "R3" calendar = "standard" range = "rolling 3" previous = "previous-year" label = "R3"

 Required

Defines the time range to use for the stamp. The available options are: current-day, month-to-date, year-to-date, rolling 3, rolling 6, and rolling 12.

NOTE: Applies to DiveTab 7.1(20) and earlier.

retina

icon "/divetab/images/icon.png" retina = true

Optional

Indicates the type of image.

The retina attribute is Boolean.
stamp

Using DiveTab 7.1(21) and later:

stamp "MTD vs Last Year MTD" label = "MTD" {

text {

month-to-date

previous-year {

difference

percent-difference

}

}

}

stamp-book "nTD" {

stamp "MTD vs Last Year MTD"

stamp "YTD vs Prev YTD"

}

 

Using DiveTab 7.1(20) and earlier:

stamp "MTD" calendar = "standard" range = "month-to-date" previous = "previous-year" label = "MTD"

stamp-book "nTD" {

stamp "MTD"

stamp "YTD"

}

 Required Defines the stamp template, or which stamps are included in the stamp-book.
stamp-book

stamp-book "Rolling" {

stamp "R3-to-Date vs LY R3-to-Date"

stamp "R6-to-Date vs LY R6-to-Date"

stamp "R12-to-Date vs LY R12-to-Date"

}

stamp-book "All" {

stamp-book "Rolling"

stamp-book "nTD"

}

measure "Accts Sold" stamp-book = "Rolling"

 Required

Defines a category for multiple stamps. These are the available stamp template options to apply to a measure. This can either be a block that identifies the stamps or stamp book in the category, or a tag to identify which stamp-book a measure uses.

NOTE: Stamps in a stamp-book block are identified by name.
text

text {

month-to-date

previous-year {

difference

percent-difference

}

}

 In DiveTab 7.1(21) and later: Required

Defines the display area in the stamp as text.

NOTE: Available in DiveTab 7.1(21) and later.
<text-comparison-tag>

text {

current-day

previous-day

versus aux-measure = "Total"

}

bar-chart {

rolling-months 12

previous-year

}

line-chart {

rolling-months 12

previous-year

}

In DiveTab 7.1(21) and later: Required

Specifies the comparison time range against the time-range-tag.

The available options in DiveTab 7.1(25) and later are:

  • previous-year

  • previous

  • versus aux-measure="A": The available aux-measure names are any auxiliary measures from the factory, such as "Total", "Target Threshold", and "Budget".

The available options in DiveTab 7.1(21) through 7.1(24) are:

  • total aux-measure = "A"

  • previous-day

Bar charts and line charts can only have previous-year as a text-comparison-tag. It is optional.

In DiveTab 7.1(21) to (24), the previous-day option can be used with the current-day time-range-tag only.

NOTE: Available in DiveTab 7.1(21) and later.
<time-range-tag>

text {

current-day

...

}

bar-chart {

rolling-months 12

...

}

line-chart {

rolling-months 12

...

}

 In DiveTab 7.1(21) and later: Required

Specifies the primary time range. It matches the range tags available in Spectre time-series. Namely:

  • current-day

  • month-to-date

  • quarter-to-date: Available in DiveTab 7.1(25) and later.

  • rolling-months 3

  • rolling-months 6

  • rolling-months 12

  • year-to-date

Bar charts and line charts can only have rolling-months 12 and year-to-date as time-range-tags.

NOTE: Available in DiveTab 7.1.(21) and later.
type

previous-year type = "month-end"

 Optional

Specifies the text-comparison-tag alongside the time-range-tag.

In DiveTab 7.1(25) and later, the complete option can only be used with the month-to-date, quarter-to-date, and year-to-date time-range-tags and the previous and previous-year text-comparison-tag. The month-end option is used with the year-to-date time-range-tag and previous or previous-year text-comparison-tag.

In DiveTab 7.1(21) through (24), the available options are same-day (default) and month-end. It can only be used with the month-to-date and year-to-date time-range-tags and the previous-year text-comparison-tag.

NOTE: Available in DiveTab 7.1(21) and later.

title

title "My Portal"

Optional

Indicates the string that appears in the title bar when the page displays.
update-time update-time aux-measure = "Update Time" format = "MMM D, YYYY" Optional

Specifies that the stamp indicates the update time. The measure in the factory must support the aux-measure defined with this option.

NOTE: Available in DiveTab 7.1(21) and later.

See also: